﻿/*
Copyright (c) 2013, Marc Tanti
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the www.marctanti.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using MARIA.program.statement;
using System.Drawing;
using System.Windows.Forms;

namespace MARIA.program.statementfactory
{
    /// <summary>
    /// Factory design pattern for statements, a different factory for each statement.
    /// </summary>
    public abstract class StatementFactory
    {

        /// <summary>
        /// The image representing the statement.
        /// </summary>
        public Image StatementImage
        {
            get
            {
                return image;
            }
        }
        private Image image;

        /// <summary>
        /// The texual representation of the statement.
        /// </summary>
        public string StatementTextualRepresentation
        {
            get
            {
                return statementTextualRepresentation;
            }
        }
        private string statementTextualRepresentation;

        /// <summary>
        /// The description of the statement.
        /// </summary>
        public string StatementDescription
        {
            get
            {
                return statementDescription;
            }
        }
        private string statementDescription;

        /// <summary>
        /// Initialize a new instance of StatementFactory from the statement's texual representation.
        /// </summary>
        /// <param name="statementTextualRepresentation">The statement textual representation.</param>
        /// <param name="image">The image representing the statement.</param>
        public StatementFactory(string statementTextualRepresentation, string statementDescription, Image image)
        {
            this.statementTextualRepresentation = statementTextualRepresentation;
            this.statementDescription = statementDescription;
            this.image = image;
        }

        /// <summary>
        /// Check if a structured text description of the statement matches the statement this factory produces (used to instantiate statements from text file content).
        /// </summary>
        /// <param name="description">The description.</param>
        /// <returns>If the description is a match.</returns>
        public abstract bool IsDescriptionValid(string description);

        /// <summary>
        /// Make an instance of Statement from a structured text description of the statement (used to instantiate statements from text file content).
        /// </summary>
        /// <param name="description">The description.</param>
        /// <returns>A new instance of statement.</returns>
        public abstract Statement MakeInstance(string description);

        /// <summary>
        /// Make an instance of Statement using default parameters.
        /// </summary>
        /// <returns>A new instance of statement.</returns>
        public abstract Statement MakeInstance();

    }
}
